home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / cmds / barg / RCS / barg.1,v < prev    next >
Encoding:
Text File  |  1988-05-18  |  4.8 KB  |  162 lines
  1. head     1.2;
  2. access   ;
  3. symbols  ;
  4. locks    ; strict;
  5. comment  @@;
  6.  
  7.  
  8. 1.2
  9. date     88.05.17.18.17.21;  author nelson;  state Exp;
  10. branches ;
  11. next     1.1;
  12.  
  13. 1.1
  14. date     88.05.17.17.27.07;  author nelson;  state Exp;
  15. branches ;
  16. next     ;
  17.  
  18.  
  19. desc
  20. @@
  21.  
  22.  
  23. 1.2
  24. log
  25. @*** empty log message ***
  26. @
  27. text
  28. @'\" $Header: barg.1,v 1.1 88/05/17 17:27:07 nelson Exp $ SPRITE (Berkeley)
  29. .TH BARG 1
  30. .SH NAME
  31. barg \- draw a bar graph in gremlin format
  32. .SH SYNOPSIS
  33. .HP
  34. barg [input_file_name [output_file_name]] 
  35. .SH DESCRIPTION
  36. .PP
  37. .I Barg
  38. is used to generate bar graphs in gremlin format.
  39. It takes up to two arguments.  The first argument is the name of the \fIbarg\fP
  40. input file.  The second argument is the name of the gremlin file to store
  41. the output of \fIbarg\fP into.  If the output file is not specified then output
  42. goes to standard output.  If the input file is also missing then input is
  43. read from standard input.
  44. .PP
  45. A \fIbarg\fP input file is an ASCII file containing \fIbarg\fP commands and 
  46. data.  Each command is on a separate line.  White space can be used to
  47. separate the different arguments to each command. 
  48. Lines beginning with a "#" and blank lines are ignored.
  49. All command arguments that affect the dimensions of the graph are specified
  50. in pixels.  
  51. .PP
  52. Graphs are divided up into sets of bars.  Each set can contain from 1 to
  53. 8 bars and there can be any number of sets.  The program is fully parameterized
  54. such that the bar width, inner bar spacing, inner set spacing, graph height
  55. and graph width can all be specified.
  56. All parameters that are not specified, except
  57. for the number of sets and the number of bars in each set which must
  58. be specified, will either default to preset values or be calculated.  If the
  59. inner set spacing is not specified or it is specified as -1,
  60. it will be calculated from the bar width,
  61. inner bar spacing and graph width.  Likewise if the inner set spacing
  62. is set but the bar width is not then it will be calculated from the other
  63. parameters.
  64. .PP
  65. The following is a summary of the \fIbarg\fP commands:
  66. .nf
  67. .sp
  68. .ul 1
  69. Command        Arguments
  70. .sp
  71. b        <left border width> <right border width>
  72. d        <data set label>
  73. h        <graph height>
  74. k        <left key border> <right key border> <key width> <key height>
  75. lx        <x-axis label>
  76. ly        <y-axis label>
  77. n        <num bar sets> <num bars per set>
  78. p
  79. s        <inner bar space> <inner set space>
  80. t        <graph title>
  81. w        <graph width>
  82. y        <# of ticks> <delta> <starting value>
  83. W        <bar width>
  84. 1        <bar type> <bar label>
  85. 2        <bar type> <bar label>
  86. 3        <bar type> <bar label>
  87. 4        <bar type> <bar label>
  88. 5        <bar type> <bar label>
  89. 6        <bar type> <bar label>
  90. 7        <bar type> <bar label>
  91. 8        <bar type> <bar label>
  92. .sp
  93. .fi
  94. The following explains each command in more detail:
  95. .IP b
  96. Define the left and right border in pixels.
  97. The left border width is the number of pixels between the y-axis
  98. and the first bar graph.  The right border width is the number of
  99. pixels that the x-axis extends past the last bar graph.
  100. .IP d
  101. Define a bar graph set.  These commands should be the last commands
  102. in the input file.  The label is the string to draw at the bottom of
  103. the bar graph set.  The following lines up until a line beginning with an
  104. "e" is found are taken as floating point y values for bars in the bar graph
  105. set. The line with the "e" marks the end of the bar graph set.  There cannot
  106. be more than the number of bars per set lines of data between the "d" and
  107. "e" commands.
  108. .IP h
  109. The graph height in pixels.
  110. .IP k
  111. Bar graph key information.  At the bottom of each graph each of the
  112. different bar types is drawn along with the associated label (see the
  113. 1-8 commands below).  The left key border specifies the number of pixels
  114. between the y-axis and the first key.  The right key border is the
  115. number of pixels between the end of the x-axis and the rightmost key.
  116. The key width and height define the size of the bar that is drawn that
  117. represents the key.
  118. .IP lx
  119. Label to print on the x-axis.
  120. .IP ly
  121. Label to print on the y-axis.
  122. .IP n
  123. Define the number of bar sets and the number of bars in each set.
  124. This command must come after the dimensions of the graph are defined and
  125. before the data sets are defined with the "d" command.
  126. .IP p
  127. Print a percent sign after each value on the y-axis.
  128. .IP s
  129. Define the number of pixels between each bar and between each set of bars. 
  130. .IP t
  131. Title the graph.
  132. .IP w
  133. The width of the graph in pixels.
  134. .IP y
  135. Define the range of the y-axis.  The # of ticks is the number of pieces
  136. to divide the y-axis into, the delta is the size of each piece and the
  137. starting value is the base value for y.
  138. .IP W
  139. The width of each bar.
  140. .IP [1-8]
  141. Define the type of the ith bar in a set.  The type must be between 0
  142. and 7 and corresponds to the 8 gremlin filled polygon types.
  143. The label is used to print out the bar type key.
  144. .SH SEE ALSO
  145. .IR gremlin(1)
  146. .SH AUTHOR
  147. Michael N. Nelson
  148. @
  149.  
  150.  
  151. 1.1
  152. log
  153. @Initial revision
  154. @
  155. text
  156. @d1 1
  157. a1 1
  158. '\" $Header$ SPRITE (Berkeley)
  159. d53 1
  160. d103 2
  161. @
  162.